/*
 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.sun.max.tele;

import com.sun.max.unsafe.*;

/**
 * Denotes a native (dynamically loaded) library in the target VM.
 *
 * See {@link System#loadLibrary(String)}
 */
public interface MaxNativeLibrary extends MaxEntity<MaxNativeLibrary> {
    /**
     * The file system path to the native library.
     */
    String path();

    /**
     * The functions in the library, or {@code null} if this information is not known (yet).
     * There is a window between opening the library and resolving the first symbol where
     * {@code null} can be returned.
     */
    MaxNativeFunction[] functions();

    /**
     * Get the native function in the library, if any, whose code includes
     * a given address in the VM; null if none.
     *
     * @param address memory location in the VM
     * @return a native function whose code includes the address, null if none
     */
    MaxNativeFunction findNativeFunction(Address address);

    Address base();

    int length();

}
